Extra deploy for additional manifests by philippeckel · Pull Request #293 · meilisearch/meilisearch-kubernetes

philippeckel · 2026-01-12T15:19:51Z

Pull Request

Related issue

Fixes #292

What does this PR do?

Add support for deploying additional Kubernetes resources alongside Meilisearch through an extraDeploy configuration option in values.yaml. This feature would allow users to define custom Kubernetes manifests (ConfigMaps, Secrets, Services, Deployments, etc.) that get deployed as part of the Helm release without needing to fork or modify the chart.

PR checklist

Please check if your PR fulfills the following requirements:

Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
Have you read the contributing guidelines?
Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

Summary by CodeRabbit

New Features
- Support for deploying extra custom resources with the release.
- New configurable options: extra deploys list, init containers, priority class, and service account token mounting.
- Service monitor can now be scoped with a configurable namespace.
Updates
- Upgraded Meilisearch image to v1.31.0.
- Chart version and metadata updated to 0.20.0; docs footer regenerated.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2026-01-12T15:20:01Z

📝 Walkthrough

Walkthrough

Adds a new extraDeploy values key and a Helm template to render user-provided Kubernetes manifests alongside Meilisearch; updates chart README metadata and documents new configurable fields and defaults.

Changes

Cohort / File(s)	Summary
Documentation & Metadata `charts/meilisearch/README.md`	Bumped chart/version badges (Version: `0.2.1` → `0.20.0`, AppVersion: `v1.2.0` → `v1.31.0`); documented new configurable fields (including `extraDeploy`, `initContainers`, `priorityClassName`, `serviceAccount.automountServiceAccountToken`, `serviceMonitor.namespace`); adjusted persistence/image defaults; updated helm-docs footer version.
Template Implementation `charts/meilisearch/templates/extra-deploy.yaml`	New template that iterates over `.Values.extraDeploy`, emits a YAML document separator per item, and renders each entry via `tpl` (supports string or object entries rendered with `toYaml`).
Configuration Values `charts/meilisearch/values.yaml`	Added `extraDeploy: []` (under serviceMonitor area per diff) to allow users to specify additional Kubernetes resources to be deployed with the chart.

Sequence Diagram(s)

(omitted — changes are template + docs and do not introduce multi-component runtime control flow)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Bump Meilisearch to v1.30.0 #287 — also updates Meilisearch chart metadata and bumps image/appVersion.
Bump Meilisearch to v1.31.0 #289 — related chart version/image.tag bump to v1.31.0.

Suggested reviewers

brunoocasali
curquiza

Poem

🐰 I stitched an extraDeploy today,
Manifests hop out to play.
Values set, templates rhyme,
Charts grow nimble, one deploy at a time.
The rabbit cheers — release hooray! 🎉

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Out of Scope Changes check	⚠️ Warning	Changes include README badge updates and helm-docs version updates, which fall outside the scope of implementing the extraDeploy feature specified in #292.	Remove README.md changes (version badges and helm-docs updates) unrelated to the extraDeploy implementation, or include them in a separate documentation maintenance PR.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Extra deploy for additional manifests' directly reflects the primary change—adding support for deploying additional Kubernetes resources via the extraDeploy feature.
Linked Issues check	✅ Passed	All coding requirements from issue #292 are met: extraDeploy array added to values.yaml, dedicated template file (extra-deploy.yaml) created with range loop implementation, and support for arbitrary Kubernetes manifests.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 06e7210 and 81d5a2d.

📒 Files selected for processing (1)

charts/meilisearch/values.yaml

🚧 Files skipped from review as they are similar to previous changes (1)

charts/meilisearch/values.yaml

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In @charts/meilisearch/templates/extra-deploy.yaml:
- Around line 1-8: The template references the wrong value name and injects
extra leading spaces into rendered manifests; change .Values.extraDeploy to
.Values.extraDeploys and remove the leading spaces before the tpl calls so the
lines reading tpl . $ and tpl (. | toYaml) $ are not indented (keep the '---'
separator line intact), ensuring the range over the correct values key and that
tpl output is emitted without unwanted leading whitespace.

In @charts/meilisearch/values.yaml:
- Around line 182-183: The Helm values key is misnamed: values.yaml defines
extraDeploys (plural) but the chart template extra-deploy.yaml reads
.Values.extraDeploy (singular), so the template never receives the data; fix by
either renaming the values key from extraDeploys to extraDeploy to match the
template, or update the template (extra-deploy.yaml) to reference
.Values.extraDeploys (plural) wherever used; ensure the symbol names
(extraDeploys or extraDeploy) are consistent between values and template.

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b39e9c3 and 06e7210.

📒 Files selected for processing (3)

charts/meilisearch/README.md
charts/meilisearch/templates/extra-deploy.yaml
charts/meilisearch/values.yaml

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

charts/meilisearch/README.md

120-120: Bare URL used

(MD034, no-bare-urls)

🪛 YAMLlint (1.37.1)

charts/meilisearch/templates/extra-deploy.yaml

[error] 1-1: syntax error: expected the node content, but found '-'

(syntax)

🔇 Additional comments (2)

charts/meilisearch/README.md (2)

66-66: Documentation reflects extraDeploys (plural).

This documentation matches values.yaml but not the template. After resolving the naming mismatch between extraDeploys and extraDeploy, regenerate this README using helm-docs to ensure consistency.

5-5: Documentation updates look good.

The helm-docs regeneration properly captures the new and updated chart values including version bumps and new configuration options.

Also applies to: 71-71, 78-78, 89-89, 99-99, 111-111, 114-114, 119-119, 121-121, 133-133

coderabbitai · 2026-01-12T15:23:59Z

+{{- range .Values.extraDeploy }}
+---
+{{- if typeIs "string" . }}
+    {{ tpl . $ }}
+{{- else }}
+    {{ tpl (. | toYaml) $ }}
+{{- end }}
+{{- end }}


⚠️ Potential issue | 🔴 Critical

Fix whitespace handling to avoid malformed YAML output.

Two issues with this template:

Naming mismatch: References .Values.extraDeploy but values.yaml defines extraDeploys (covered in values.yaml comment).

Leading whitespace: Lines 4 and 6 have leading spaces that will be included in the rendered output, causing indentation issues in the generated manifests.

🐛 Proposed fix

{{- range .Values.extraDeploy }} --- -{{- if typeIs "string" . }} - {{ tpl . $ }} -{{- else }} - {{ tpl (. | toYaml) $ }} -{{- end }} +{{ if typeIs "string" . }} +{{ tpl . $ }} +{{- else }} +{{ tpl (toYaml .) $ }} +{{- end }} {{- end }}

Note: The YAMLlint syntax error is a false positive since this is a Helm template, not a standalone YAML file.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

{{- range .Values.extraDeploy }}

---

{{- if typeIs "string" . }}

{{ tpl . $ }}

{{- else }}

{{ tpl (. | toYaml) $ }}

{{- end }}

{{- end }}

{{- range .Values.extraDeploy }}

---

{{ if typeIs "string" . }}

{{ tpl . $ }}

{{- else }}

{{ tpl (toYaml .) $ }}

{{- end }}

{{- end }}

🧰 Tools

🪛 YAMLlint (1.37.1)

[error] 1-1: syntax error: expected the node content, but found '-'

(syntax)

🤖 Prompt for AI Agents

In @charts/meilisearch/templates/extra-deploy.yaml around lines 1 - 8, The template references the wrong value name and injects extra leading spaces into rendered manifests; change .Values.extraDeploy to .Values.extraDeploys and remove the leading spaces before the tpl calls so the lines reading tpl . $ and tpl (. | toYaml) $ are not indented (keep the '---' separator line intact), ensuring the range over the correct values key and that tpl output is emitted without unwanted leading whitespace.

brunoocasali · 2026-02-09T11:22:32Z

Hi there, can you update the chart version? This way we can proceed with the merge :)

brunoocasali · 2026-02-09T11:22:59Z

 | envFrom | list | `[]` | Additional environment variables from ConfigMap or secrets |
 | environment.MEILI_ENV | string | `"development"` | Sets the environment. Either **production** or **development** |
 | environment.MEILI_NO_ANALYTICS | bool | `true` | Deactivates analytics |
+| extraDeploys | list | `[]` | Extra objects to deploy with the release |


Or maybe we should keep extraDeploys everywhere?

philippeckel added 3 commits January 12, 2026 16:13

feat: meilisearch#292 add template for extraDeploy

2fe6245

chore: meilisearch#292 update README.md using helm-docs

23f3aea

chore: meilisearch#292 add extra line

06e7210

coderabbitai Bot reviewed Jan 12, 2026

View reviewed changes

fix: meilisearch#292 fix typo

81d5a2d

brunoocasali reviewed Feb 9, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extra deploy for additional manifests#293

Extra deploy for additional manifests#293
philippeckel wants to merge 4 commits into
meilisearch:mainfrom
philippeckel:extra-deploy

philippeckel commented Jan 12, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jan 12, 2026 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Jan 12, 2026

Uh oh!

Uh oh!

brunoocasali commented Feb 9, 2026

Uh oh!

brunoocasali Feb 9, 2026

Uh oh!

brunoocasali Feb 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	\| extraDeploys \| list \| `[]` \| Extra objects to deploy with the release \|
	\| extraDeploy \| list \| `[]` \| Extra objects to deploy with the release \|

Conversation

philippeckel commented Jan 12, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

Related issue

What does this PR do?

PR checklist

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

brunoocasali commented Feb 9, 2026

Uh oh!

brunoocasali Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

brunoocasali Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

philippeckel commented Jan 12, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jan 12, 2026 •

edited

Loading